-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add contributor guide #5426
Add contributor guide #5426
Conversation
This PR has multiple commits, and the default merge method is: merge. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Hi @ncapps. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/ok-to-test |
/label tide/merge-method-squas |
@ncapps: The label(s) In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/label tide/merge-method-squash |
Looks good to me /lgtm |
@antoooks: changing LGTM is restricted to collaborators In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some minor comments.
CONTRIBUTING.md
Outdated
You will need to periodically fetch changes from the `upstream` repository to keep your working branch in sync. | ||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Below is an example of creating a new branch to work on.
Maybe we can add example of syncing working branches that were already created on upstream repository changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1. I think it'd be a good idea to split the part that speaks to syncing a fork from the part that creates a new working branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
from the contributor side, this lgtm
/lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @ncapps, thanks for working on this! 😄
I left a few suggestions in comments and a small correction for a link that's not currently working.
CONTRIBUTING.md
Outdated
You will need to periodically fetch changes from the `upstream` repository to keep your working branch in sync. | ||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1. I think it'd be a good idea to split the part that speaks to syncing a fork from the part that creates a new working branch.
0a423e2
to
be35c55
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
only one minor question
8947d18
to
08fa96f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve
/hold in case there are other changes you want to make before this merges
Feel free to remove the hold with /hold cancel
when you are ready to merge (or ping me if the bot doesn't respond to your command
cd kustomize | ||
|
||
# Configure upstream | ||
git remote add upstream https://github.com/kubernetes-sigs/kustomize |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Genuine question (you don't have to change anything if this is how you have yours set up, since it seems to be working great) - Does it make a difference if we use the ssh URL for the upstream vs the http one? I have my upstream configured with the ssh one, but I'm not sure if that actually affects anything in our workflows
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only difference I think I've observed is that
- ssh: you need to authenticate for push and pull, but you can use 2 factor
- http: you only need to authenticate for push, but you need to enter your password
Given that we don't need to push to upstream, I think http is probably easier
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: natasha41575, ncapps The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/hold cancel |
* Add contributor guide * git merge upstream/master * git rebase upstream/master * make test-unit-all * make lint
Add a contributor guide.
Resolves #5199